Skip to content

Commit 91e5eaa

Browse files
authored
Trivial README changes
Mostly simple capitalization, but really started because of broken links to markup folder.
1 parent 255aafa commit 91e5eaa

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -24,33 +24,33 @@ More DS tools [here](https://github.com/SymDSTools)
2424

2525
## Structure
2626

27-
- **docs:** The latest generated documentation for the Github Pages preview
27+
- **docs:** The latest generated documentation for the GitHub Pages preview
2828
- **files:** docs source files and generation scripts
2929

30-
The docs sources are written in a custom [markup format](files/markdown/README.md). For legacy reasons those markup files will be converted into an intermediate [JSON Format](files/json/README.md) which will then be converted to the html docs you all know and love.
30+
The docs sources are written in a custom [markup format](files/markup/README.md). For legacy reasons those markup files will be converted into an intermediate [JSON Format](files/json/README.md) which will then be converted to the HTML docs you all know and love.
3131

3232
## For Contributors:
3333

34-
To contribute to the Docs you need to have an active GitHub account. [Sign up](https://github.com/signup?source_repo=DroidScript%2FDocs) if you dont have one.
34+
To contribute to the Docs you need to have an active GitHub account. [Sign up](https://github.com/signup?source_repo=DroidScript%2FDocs) if you don't have one.
3535

3636
### Fork the DroidScript Repository
3737
To edit the Docs you need to 'fork' the DroidScript repository. The easiest way is to open up a new Codespace on the DroidScript repository.
3838

3939
<p align="center"><img src="files/Screenshot-Codespace.jpg" alt="Open Codespace Dialog" width="100%" style="max-width:1000px"></p>
4040

4141
### Make Changes
42-
When the Codespace is open navigate to the files/markup/en directory and make changes on any file you want to contribute. DroidScript has multiple scopes each having its own subdirectory with every possible method defined as _markup.js_ file. Inside you can modify the description, subfunctions, parameters and more. Make sure to follow the [markup format](files/markdown/README.md)!
42+
When the Codespace is open, navigate to the files/markup/en directory and make changes on any file you want to contribute. DroidScript has multiple scopes each having its own subdirectory with every possible method defined as _markup.js_ file. Inside you can modify the description, subfunctions, parameters and more. Make sure to follow the [markup format](files/markup/README.md)!
4343

4444
### Commit Changes
4545
When you finished your changes switch to the git tab on the left and descibe briefly what you have changed in the commit message field. The first line should describe what you did in general and each following line should include a more detailed list of your changes.\
46-
After that commit and synchronize your changes to github with the green button below. If you just opened the Codespace on the DroidScript repository it will ask to create a fork.
46+
After that commit and synchronize your changes to GitHub with the green button below. If you just opened the Codespace on the DroidScript repository it will ask to create a fork.
4747

4848
**Note:** there is an ongoing Codespace bug that prevents you from committing to your fork. If that applies to you, open your workspace terminal and execute `git push --set-upstream origin master`
4949

5050
<p align="center"><img src="files/Screenshot-Changes.jpg" alt="Commit Description Dialog" width="100%" style="max-width:1000px"></p>
5151

5252
### Create a Pull Request
53-
When you are satisfied with your changes and want us to review your changes, go on to the github tab on the left and hit the small 'Create Pull Request' Button that appears on the 'Pull Requests' dropdown menu. This will open a new 'Pull Request' tab where you can provide a description of your changes across all commits you made. You can also review all your commits and changed files. After that hit the green 'Create' button.
53+
When you are satisfied with your changes and want us to review your changes, go on to the GitHub tab on the left and hit the small 'Create Pull Request' Button that appears on the 'Pull Requests' dropdown menu. This will open a new 'Pull Request' tab where you can provide a description of your changes across all commits you made. You can also review all your commits and changed files. After that hit the green 'Create' button.
5454

5555
<p align="center"><img src="files/Screenshot-PullRequest.jpg" alt="Pull Request Dialog" width="100%" style="max-width:1000px"></p>
5656

0 commit comments

Comments
 (0)