Skip to content

Commit 1491529

Browse files
author
llaske
committed
Documentation update for v1.1
1 parent bfff161 commit 1491529

File tree

4 files changed

+14
-20
lines changed

4 files changed

+14
-20
lines changed

CHANGELOG.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
55
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
66

7-
## [Unreleased]
7+
## [1.1.0] - 2019-01-20
88
### Added
99
- Desktop version for GNU Linux, MacOS and Windows using electron
1010
- Ebook Reader activity
@@ -51,6 +51,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
5151
- Remove Cordova activity
5252
- Remove Welcome Web activity
5353
- Chrome OS version
54+
- Windows 10 version from the store, now using an installer
5455

5556

5657
## [1.0.1] - 2018-07-07

README.md

+12-19
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Enjoy the experience and help us reach every child on every device in every coun
1818

1919
# Sugarizer Application
2020

21-
Sugarizer Application is a cross-platform application for installing on any GNU+Linux, Windows, Mac OS X, Android, iOS, or Chrome OS device.
21+
Sugarizer Application is a cross-platform application for installing on any GNU+Linux, Windows, Mac OS X, Android or iOS device.
2222

2323
To run **Sugarizer Application on Android**, download it on [Google Play](https://play.google.com/store/apps/details?id=org.olpc_france.sugarizer), [Amazon Store](http://www.amazon.com/gp/product/B00NKK7PZA) or [F-Droid](https://f-droid.org/repository/browse/?fdid=org.olpc_france.sugarizer).
2424

@@ -36,15 +36,14 @@ To run **Sugarizer Application on iOS**, download it on [Apple Store](https://it
3636

3737
![](images/applestore.png)
3838

39-
To run **Sugarizer Application on Windows 10**, download it on [Windows Store](https://www.microsoft.com/store/apps/9nblggh4r782). You could also build yourself the Sugarizer Windows Application using instructions below.
39+
To run **Sugarizer Application on GNU Linux/Mac OS/Windows**, download it [here](https://sugarizer.org#desktop).
40+
The Sugarizer desktop application has three possible arguments:
4041

41-
![](images/windowstore.png)
42+
* `--window` to open Sugarizer in a window (instead of fullscreen)
43+
* `--debug` to open Sugarizer with the debug console
44+
* `--init` to remove all existing Journal and settings (all will be lost)
4245

43-
To run **Sugarizer Application as Chrome Web App**, download it from the [Chrome Web Store](https://chrome.google.com/webstore/detail/sugarizer/omfgclgehghdlloggibhgicnlldjiboo) or use the [Chrome Apps & Extensions Developer Tool](https://chrome.google.com/webstore/detail/chrome-apps-extensions-de/ohmmkhmmmpcnpikjeljgnaoabkaalbgc) and use the Sugarizer directory as the target for the unpacked application.
44-
45-
![](images/chromewebstore.png)
46-
47-
To run **Sugarizer Application on GNU Linux/Mac OS/Windows**, you could use [electron](https://github.com/electron/electron). So first install Node.js and npm on your computer. See [here](http://nodejs.org/) for more information. Then install electron and specific modules for Sugarizer by running:
46+
If you're a developer you could also launch Sugarizer desktop application using [electron](https://github.com/electron/electron). First install Node.js and npm on your computer. See [here](http://nodejs.org/) for more information. Then install electron and specific modules for Sugarizer by running:
4847

4948
npm install
5049

@@ -56,15 +55,9 @@ Or, for Mac OS/Windows, just:
5655

5756
npm start
5857

59-
The "start" command has three possible arguments:
60-
61-
* "--window" to open Sugarizer in a window (instead of fullscreen)
62-
* "--debug" to open Sugarizer with the debug console
63-
* "--init" to remove all existing Journal and settings (all will be lost)
58+
You could use Sugarizer desktop arguments using "--" after start. For example:
6459

65-
For example if you want to combine two arguments:
66-
67-
npm start -- --debug --window
60+
npm start -- --window
6861

6962
To run **Sugarizer Application from the Web Browser** (GNU Linux/Mac OS/Windows), you should launch it with a special option to enable access to local files.
7063

@@ -75,7 +68,7 @@ For **Chrome**, close ALL running instances of Chrome and re-launch it using the
7568
On Windows, you should launch:
7669

7770
"C:\Program Files (x86)\Google\Chrome\Application\chrome.exe" --allow-file-access-from-files
78-
71+
7972
On Mac OS, you should launch:
8073

8174
open -n /Applications/Google\ Chrome.app --args --allow-file-access-from-files
@@ -185,9 +178,9 @@ Let's start [here](docs/tutorial.md).
185178
To run unit tests for Sugarizer Application, run "file:///PathToYourSugarizerRepo/test/index.html" in your browser.
186179

187180

188-
# Build Application for Android, iOS or Windows 10
181+
# Build Application for Android and iOS
189182

190-
Sugarizer Application could be packaged as an Android, iOS and Windows 10 application using [Cordova](http://cordova.apache.org/).
183+
Sugarizer Application could be packaged as an Android or iOS application using [Cordova](http://cordova.apache.org/).
191184

192185
To build it, first install Cordova as described [here](http://cordova.apache.org/).
193186

images/chromewebstore.png

-6.52 KB
Binary file not shown.

images/windowstore.png

-6.28 KB
Binary file not shown.

0 commit comments

Comments
 (0)