forked from fabriziotappero/Free-Range-VHDL-book
-
Notifications
You must be signed in to change notification settings - Fork 0
/
contribute
41 lines (28 loc) · 1.41 KB
/
contribute
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
#### FREE RANGE VHDL - how to contribute ####
FREE RANGE VHDL is written in Latex. The source code is available from:
https://github.com/fabriziotappero/Free-Range-VHDL-book
To help out with the book you can point out problems or suggestions
by sending me an e-mail at:
http://freerangefactory.org/#contact
Alternatively, you can get the Latex source, edit it and sending me a
patch. If you like that please keep reading.
git (www.git-scm.com) is the version control system used to menage the
content of this book. I personally use the Git Shell command line.
1) Get the latest latex version of the book from github:
git clone https://github.com/fabriziotappero/Free-Range-VHDL-book.git
cd Free-Range-VHDL-book-master
2) you can see the history of the latest version of the book with:
gitk
4) Modify and save any file you want.
5) If you have Latex installed in your machine, use the command "compile"
and the command "clean" to compile and clean your final PDF.
check the status of your work with the command:
git status
5) create a patch with the command:
git diff > my_patch.patch
6) copy and paste the content of the patch file and an explanation of what
you have done in:
http://freerangefactory.org/#contact
AN ALTERNATIVE AND MODERN WAY IS TO GENERATE A GITHUB PULL REQUEST.
https://yangsu.github.io/pull-request-tutorial/
I would love to hear your suggestions and get your help!