andreika-git
/
rusefi_documentation
mirror of https://github.com/andreika-git/rusefi_documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'remotes/wiki-git/master'

This commit is contained in:
rusefi 2019-12-30 12:31:12 -05:00
parent dfc1763130 e2fe0afbde
commit 0176f6366c
2 changed files with 37 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
FAQ/HOWTO_contribute_to_documentation.md
View File

@ -1,4 +1,31 @@
#### How to contribute to https://github.com/rusefi/rusefi_documentation
Step 1: Sign up or sign in to https://github.com
Step 2: Open https://github.com/rusefi/rusefi_documentation and click 'Fork' - this would produce your own fork/copy of rusefi_documentation which you can now edit right in your browser!
![editor](github_online_editor.png)
Step 3: Edit your code and Commit changes using the button below the editor.
Step 4: Once you are ready to contribute your changes, hit 'New pull request' button on the main page of your fork.
This would produce a [Pull request like this](https://github.com/rusefi/rusefi_documentation/pull/3) in the official rusefi repository and your changes would probably soon become public!
https://github.com/rusefi/rusefi/blob/master/firmware/tunerstudio/rusefi.input
#### How to contribute to rusEfi TunerStudio project
Same as above, fork https://github.com/rusefi/rusefi and edit your local copy of
https://github.com/rusefi/rusefi/blob/master/firmware/tunerstudio/rusefi.input file
https://github.com/rusefi/rusefi/commit/9d9ae5a05499027b32ed76df3e7ee2e2e8240c31 is an example of how more help could be added
right into TunerStudio project file. Lines with green background are the lines being added.
Unfortunately while you would be modifying your mainController.ini file while trying your changes, you need to edit rusefi.input file which
is a template from which rusefi.ini is generated programmatically on rusefi side.
# Technical implementation details
@ -19,3 +46,12 @@ merged into https://github.com/rusefi/rusefi_documentation, complete https://git
into https://github.com/rusefi/rusefi_documentation.wiki.git which makes actual content nicely visible at https://github.com/rusefi/rusefi_documentation/wiki
# Technical FAQ
Q: Is it ok that https://github.com/rusefi/rusefi_documentation.wiki.git cannot be opened from browser?
A: There is no reason to open https://github.com/rusefi/rusefi_documentation.wiki.git from browser. Also while you technically
CAN "git clone https://github.com/rusefi/rusefi_documentation.wiki.git" and it would work -
you should NOT. Anyone looking to make changes should be making changes to non-wiki git via normal fork & pull request process.
Additional automation is in charge of merging from https://github.com/rusefi/rusefi_documentation.git into https://github.com/rusefi/rusefi_documentation.wiki.git

29
FAQ/HOWTO_help_rusEfi.md
View File

@ -3,34 +3,7 @@
The weakest point of rusEfi is documentation. If you've played with rusEfi for any time chances are you have help improve the documentation.
[Click here for more details](HOWTO_contribute_to_documentation.md)
#### How to contribute to https://github.com/rusefi/rusefi_documentation
Step 1: Sign up or sign in to https://github.com
Step 2: Open https://github.com/rusefi/rusefi_documentation and click 'Fork' - this would produce your own fork/copy of rusefi_documentation which you can now edit right in your browser!
![editor](github_online_editor.png)
Step 3: Edit your code and Commit changes using the button below the editor.
Step 4: Once you are ready to contribute your changes, hit 'New pull request' button on the main page of your fork.
This would produce a [Pull request like this](https://github.com/rusefi/rusefi_documentation/pull/3) in the official rusefi repository and your changes would probably soon become public!
https://github.com/rusefi/rusefi/blob/master/firmware/tunerstudio/rusefi.input
#### How to contribute to rusEfi TunerStudio project
Same as above, fork https://github.com/rusefi/rusefi and edit your local copy of
https://github.com/rusefi/rusefi/blob/master/firmware/tunerstudio/rusefi.input file
https://github.com/rusefi/rusefi/commit/9d9ae5a05499027b32ed76df3e7ee2e2e8240c31 is an example of how more help could be added
right into TunerStudio project file. Lines with green background are the lines being added.
Unfortunately while you would be modifying your mainController.ini file while trying your changes, you need to edit rusefi.input file which
is a template from which rusefi.ini is generated programmatically on rusefi side.
[Click here for more details](HOWTO_contribute_to_documentation)