Skip to content

Commit

Permalink
More readme goodness
Browse files Browse the repository at this point in the history
  • Loading branch information
tjvr committed Oct 17, 2017
1 parent d877ab9 commit 335cee8
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 6 deletions.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@

This is a rewrite of [Tosh](http://tosh.tjvr.org/), my text-based Scratch project editor.

This version is open-source, with a readable, modern codebase.


Dependencies
Expand All @@ -14,5 +17,34 @@ Dependencies
Current status
==============

???
* Load/save seems to work
* Importing / compiling scripts is there, but needs extensive testing & improvement
* Measuring scripts is fully implemented & tested (so we can "clean up" when saving to sb2)
* Playing projects seems to work

* No sprite management
* No costume management (nor am I particularly interested in adding this!)
* Highlighting almost works
* Completion is in-progress but goodness it's a difficult problem

Future plans:

* A desktop version for Win/Mac based on my unreleased lightweight Electron clone


Running
=======

```sh
git clone --recursive https://github.com/tjvr/tosh2
cd tosh2
echo ';window.P = P' >> phosphorus/phosphorus.js
yarn
yarn grammar && yarn test
yarn start
```

<http://localhost:8080/app/>

If someone wants to set up browserify/babelify for bundling, that would be excellent

6 changes: 1 addition & 5 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2222,18 +2222,14 @@ minimatch@^3.0.0, minimatch@^3.0.2, minimatch@^3.0.3, minimatch@^3.0.4:
dependencies:
brace-expansion "^1.1.7"

[email protected]:
[email protected], minimist@~0.0.1:
version "0.0.8"
resolved "https://registry.yarnpkg.com/minimist/-/minimist-0.0.8.tgz#857fcabfc3397d2625b8228262e86aa7a011b05d"

minimist@^1.1.0, minimist@^1.1.1, minimist@^1.2.0:
version "1.2.0"
resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.0.tgz#a35008b20f41383eec1fb914f4cd5df79a264284"

minimist@~0.0.1:
version "0.0.10"
resolved "https://registry.yarnpkg.com/minimist/-/minimist-0.0.10.tgz#de3f98543dbf96082be48ad1a0c7cda836301dcf"

[email protected], "mkdirp@>=0.5 0", mkdirp@^0.5.1, mkdirp@~0.5.0:
version "0.5.1"
resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-0.5.1.tgz#30057438eac6cf7f8c4767f38648d6697d75c903"
Expand Down

0 comments on commit 335cee8

Please sign in to comment.