diff --git a/_posts/2014-10-05-how-to-get-involved.md b/_posts/2014-10-05-how-to-get-involved.md index b2d5b4e..881e6fc 100644 --- a/_posts/2014-10-05-how-to-get-involved.md +++ b/_posts/2014-10-05-how-to-get-involved.md @@ -1,6 +1,6 @@ --- layout: post -title: "How You Can Get Involved" +title: "How to get involve" date: 2014-10-05 22:34:25 categories: Help Git @@ -8,52 +8,54 @@ image: /JceManager/assets/images/posts/big-data.jpg img: big-data.jpg --- -# Okay, You want to get involved... -######*There are few ways you can help* +# Getting involved +######There are few ways you can to it -First of all, thank you for using our software, And even more thanks for your willing to help! +First of all, we would like to thank you for using our software, And even more thanks for your willing to help! -You do not need to know how to program in order to help us out! -Help is not always contributing by code; There are several ways to do so: +You do not need to know how to program in order to help us out. +Help is not always contributing by code but also helping us with ideas. +There are several ways to do so: - [Asking for new features][ask] - [Posting bug reports][bugs] - [Develope][code] -In this post we will cover all methods in great detail.
+In this post we will cover all methods in great details.
Note that all these methods are welcome in all Open-Source software and it will help you getting involved in most of them. -> You can click on one of the above to skip to that section. +> You can click on one of the links above to skip to that section. -# Asking For New Features -######*You love the software and you have a great idea* +# Asking for new features +######You love the software and you have a great idea -If that is the case, and you do have a great idea. The simple way of doing so is to contact the Developer.
You can send [Liran][liran] Or [Sagi][sagi] an e-mail. -At the mail subject please write **"JCE Manager - feature request"** - ->Please do not send twice, and do not get angry if we don't reply right away. We both are students (Just like you) and we code on our free time. +If that is the case, and you do have a great idea, The simple way of doing so is to contact the Developer. +
+You can send [Liran][liran] Or [Sagi][sagi] an e-mail, containing a subject "Jce Manager feature request". The other way, is to head over to our [ github issues page][githubissue]. -Now just create a new issue with the title
**"feature request - (a short description)"** +Just create a new issue with the title "Feature request" and in the body give us a brief about your idea.
At the body please write as much as you can, so we would understand and get to work. ->**Note:** We might not accept all features, some might not be as important as the others and we simply need to manage our time. +>Note: We might not accept all features, some might not be as important as the others and we simply need to manage our time. [ Back To The Top][top] --- -# Posting Bug Reports +# Posting bug reports ######*JCE Manager Crashed? Something wen wrong?* -Okay, sorry if something went wrong... we really test the software like **CrAzY** before we upload a new release. But if you are here, then something unacceptable happend. +Something went wrong... we test the software before we upload a new release. +But if you are here, then something went wrong... :-( For bugs, please do not send us e-mail. It will get lost in our inbox. -Go to our [ github issues page][githubissue] -and browse through the issues. try to see if someone has the same issue. If so, Click on that issue and post your experience. Also, paste the content of your log file. +Go to our [ github issues page][githubissue] and browse through the issues. +try to see if someone has the same issue, If so, Click on that issue and post your experience. +Please add your JML.log (log file. it does NOT contain your password). If your issue is new, you are more than welcome to open an issue post. Make sure that the title is short and informative. In the body, try to provide steps to reproduce + The problem + log file.
For example: @@ -77,7 +79,7 @@ Log: ``` ->**Note:** The Log file will be in the application folder. the name of the file is JMLog.log +>Note: The Log file will be in the application folder. the name of the file is JMLog.log [ Back To The Top][top] @@ -87,7 +89,7 @@ Log: # Code ######*"Talks are cheap, Show me the code"* -If you got this far, I can asume that you know some basic stuff. +If you got this far, I assume you know some basic stuff. Please make sure that you have the following: @@ -95,13 +97,10 @@ Please make sure that you have the following: 2. [git][git] 3. [a github account][github] ->**Note:** If you want to program under Windows, you might come to some issues. -Just Google it. -UNIX and UNIX like systems are most recomended (Linux / Mac OSX) +Install [qt creator][qt] -**Install [qt creator][qt]**. Download the installer... (I don't need to explain how right?). - -**Install [git][git]:**
+Install [git][git]: +
Under linux just use your package manager, apt-get, yum , pacman...
For example: {% highlight bash %} @@ -112,26 +111,30 @@ $ sudo pacman -S git {% endhighlight %} Under Mac OSX: +
If you have Homebrew installed, install Git via the command {% highlight bash %} $ brew install git {% endhighlight %} If not, download the installer... -Under Windows: Download the Git installer from the website, at the Installer Wizard, make sure you use git Bash. Now cross your fingers and hope that it goes well… +Under Windows: +
+Download the Git installer from the website, at the Installer Wizard, make sure you use git Bash. -**Create A Github account**
+Create a Github account**
Go to [github.com][github] and sign up. -Okay, Now we have everything we need to get started. well, one more thing...
+Okay, Now we have everything we need to get started. +
If it is the first time you installed [git][git] we need to set it up. ->**Note:** We are not going to learn about git, If you dont know -how to use it, Google it! It's essential for collaborating with us, and in general it's really good to know. +>Note: We are not going to learn about git, If you dont know +how to use it, Google it! It's an essential for development collaborating. -To Setup git, fire up a terminal (in Windows git bash... or something like it... please choose a better OS ). +To Setup git, fire up a terminal (in Windows use git bash) And type: {% highlight bash %} @@ -143,19 +146,18 @@ $ git config --global user.email "YOUR EMAIL ADDRESS" $ git config --global color.ui auto {% endhighlight %} -**And We Are Ready!!** +And We Are Ready!! To start messing arround with the code, you will want to fork the repo. -Go To [*JCE Manager* github repo][repo], and click on the "Fork" button on top. -that will create a copy of the software on your account. +Go to [*JCE Manager* github repo][repo], and click the "Fork" button on top. +It will create a copy of the software's code on your account. Then You will want to pull the source code to your computer. copy the URL address of the copy you've just created (should be some thing like: https://github.com/yourusername/JceManager.git) -Let's call that URL **repoPath** from now on. +Let's call that URL repoPath from now on. Now navigate to your working directory, in my case Dev folder. -You will then f {% highlight bash %} ~$ cd Dev @@ -171,8 +173,6 @@ At this point you can do whatever you want with the code and push to your github If you want us to pull code from you, it could be a bug fix, a new feature you coded or whatnot just send us a pull request at github! - - [ Back To The Top][top] --- diff --git a/_posts/2014-10-05-jce-manager-version-1-0.markdown b/_posts/2014-10-05-jce-manager-version-1-0.markdown index c761edc..a2fbe49 100644 --- a/_posts/2014-10-05-jce-manager-version-1-0.markdown +++ b/_posts/2014-10-05-jce-manager-version-1-0.markdown @@ -1,44 +1,43 @@ --- layout: post -title: "JCE Manager Version 1.0 Released!" +title: "JceManager version 1.0 is released!" date: 2014-10-05 20:34:25 categories: Releases tags: featured image: /JceManager/assets/article_images/first-release/desktop.JPG img: v1.png --- -#Proud To Announce Our First Release! -####*JCE Manager v1.0 is now public* +#We are proud to announce our first release! +####*JceManager v1.0 is now public for JCE's students*
-After **hard** development, hacking and some *Moadey beit* , we are finaly -happy with the result. The project is now avalible. +After a hard working development, we are finaly happy with the result as the project is now avalible. ->You can read more about *JCE Manager*, and its team at [About Page][about]. +>You can read more about JCE Manager and our team at [About Page][about]. -####V1.0 Release Notes: - - Login into [JCE Student web site][jce] ("Yedion") - - Extract your GPA +####Version 1.0 Release notes: + - Login into the student's portal [JCE Student web site][jce] + - Extract your GPA into table - Edit your grades to see how it affects your GPA - - Save your *username* and *password* for easy access (Password is encrypted) - - Fetch your Semester Schedule - - Export your Semester Schedule to CSV file to import to GoogleCalendar/iCal/Outlook - - Translated to Hebrew and English + - Save your username and password for easy access (Password is encrypted) + - Extract your semester's schedule and export it into a .CSV file (and import to GoogleCalendar/iCal/Outlook) + - Translation in Hebrew and English -*JCE Manager* is avalible for Windows, OS X and Linux. +JCE Manager is avalible for Windows. +(We are working on OS X and Linux) - >**Note:** + >Note: > - >Changing your grades will **not** affect the records at JCE. + >Changing your grades will NOT affect the records at JCE. --- >Head over to the [**Download Page**][download] to get a fresh copy. --- - >**Need some help? Head over to the [Help Page][help]** + >Need some help? Go to the [Help Page][help] [jce]: https://yedion.jce.ac.il/student/