cmod3 icon indicating copy to clipboard operation
cmod3 copied to clipboard

Published 20 hours ago • verified publisher icon jllodra

Update the Wiki

Open jllodra opened this issue 8 years ago • 4 comments

Currently the Wiki has 2 pages (how to run and how to build):

https://github.com/jllodra/cmod3/wiki

The wiki should look more like:

  • For Developers:
    • How to Run (Windows)
    • How to Run (macOS)
    • How to Run (Linux)
    • How to Build (Windows)
    • How to Build (macOS)
    • How to Build (Linux)
  • For Users:
    • How to install cmod3 (Windows)
    • How to install cmod3 (macOS)
    • How to install cmod3 (Linux)
    • A basic guide on cmod3 features

And all these pages with well-explained and detailed steps.

Please leave a comment if you would like to help with this issue and we'll talk about the steps to do. I see this as an interesting task if you want to enter in the world of JS apps wrapped in nwjs (or electron) or angularjs. You are very welcome.

Feel free to ask for clarification.

Thank you!

PS: I suggest doing this as different .md files (one for each subtopic) on the repository. I will mimic them on the Wiki if necessary.

jllodra avatar Oct 07 '16 10:10 jllodra

Hey there! How can i help?

cbsorrilha avatar Oct 07 '16 15:10 cbsorrilha

Hi @cbsorrilha,

Thanks for the interest.

For example, you could start by Forking the project (take a loot at the contributing.md file) and adding some Markdown files. I am looking for files like these:

  • run-cmod3-on-windows.md
  • run-cmod3-on-mac.md
  • run-cmod3-on-linux.md
  • build-cmod3-on-windows.md
  • build-cmod3-on-mac.md
  • build-cmod3-on-linux.md
  • basic-guide-to-cmod3-features.md

These files will help other developers to get involved in the code, since the most complex process now is knowing how to setup a developing environment.

For example, let's say you are running Windows and you feel comfortable with it, you could write the -on-windows.md files.

I can provide you some basic instructions I wrote some time ago, what I expect from you is to rewrite them and make them easier and better, especially the build instructions.

https://github.com/jllodra/cmod3/wiki

The first I'd do if I were you is forking the repo, clone it on your computer and try to follow the instructions in the Wiki and rewrite them in a markdown (.md) file.

While this task is easy, it is crucial and will help other developers to start contributing to the source code.

We can chat through Gitter in case you need more help: https://gitter.im/jllodra/cmod3

jllodra avatar Oct 07 '16 16:10 jllodra

Hi , I wanna help this is going to be my first contribution !

adalbertobrant avatar Oct 14 '17 10:10 adalbertobrant

Hi @adalbertobrant, you are welcome, since the other guy did nothing. You can follow the guidelines I proposed, or just do what you think is better.

Thanks

jllodra avatar Oct 14 '17 13:10 jllodra