Skip to content

Commit

Permalink
マニュアルを微修正
Browse files Browse the repository at this point in the history
  • Loading branch information
kujirahand committed Apr 16, 2018
1 parent 2185b28 commit 9e4be65
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 27 deletions.
26 changes: 16 additions & 10 deletions doc/SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](http://standardjs.com)

なでしこ3自身を開発する手順をまとめたもの。なでしこ3を使うだけならば、以下の手順は不要。

[Node.js](https://nodejs.org/ja/)をインストールしておく。

コマンドラインから以下を実行して、必要なライブラリをシステムにインストール。

このとき、npm installするときに、なでしこのモジュールで、Native Add-onを使うものがあるため、ビルド環境を整える必要がある。

【Windows】であれば、コンパイル環境が必要になるので、ビルドツールをインストールする。PowerShellから以下のコマンドを実行すると、自動的に必要なツールが入る。(Windowsのユーザー名に日本語が使われているとうまくコンパイルできないという情報もあるので注意。)
## 【Windows】

コンパイル環境が必要になるので、ビルドツールをインストールする。PowerShellから以下のコマンドを実行すると、自動的に必要なツールが入る。(Windowsのユーザー名に日本語が使われているとうまくコンパイルできないという情報もあるので注意。)

また、Gitなどのツールをインストールするために、Chocolatey(https://chocolatey.org/)をインストールしておく。

Expand All @@ -21,9 +25,13 @@ npm install -g node-gyp
npm install -g windows-build-tools
```

【macOS】でもHomebrew(そしてXcode)をインストールしておくと安心。
## 【macOS】

Homebrew(そしてXcode)をインストールしておく。

【共通】以下、共通の作業となる。(electron と asar は GUIをやるときに追加。ネット回線が細い人は抜かして実行しても良い)
##【共通】

以下、共通の作業となる。(electron と asar は GUIをやるときに追加。ネット回線が細い人は抜かして実行しても良い)

```
$ npm install -g npm-check-updates electron asar
Expand All @@ -38,7 +46,7 @@ $ npm install --no-optional
```

コマンドラインから以下のコマンドを実行することで、ソースコードをビルドできる。
これは、srcディレクトリの中のコードを編集すると、releaseディレクトリに結果が出力されるものだ
srcディレクトリの中のコードを編集すると、releaseディレクトリに結果が出力される

```
# Node.js用のソースコードをWeb用のJSに変換
Expand Down Expand Up @@ -82,9 +90,9 @@ apm install linter-js-standard

なでしこ3では、コマンドラインからなでしこを実行できる、cnako3(Windowsは、cnako3.bat)というスクリプトを用意。今後、なでしこの各種バッチファイルは、なでしこ自身で記述される。

ちなみに、``npm install -g nadeisko3`` を実行すると、npmコマンドでcnako3コマンドが利用できるようになるが、それは安定版のなでしこがインストールされる
ちなみに、``npm install -g nadeisko3`` を実行すると、npmコマンドでcnako3コマンドが利用できるようになるが、その場合は安定版のなでしこがインストールされることになる

そこで、環境変数に、本ファイルのパスを、NAKO_HOMEとして登録し、パスを NAKO_HOME/src に通す。以下、macOS/Linuxでの.bashrcの記述例。(ユーザー名がkujiraの場合)
環境変数に、本ファイルのパスを、NAKO_HOMEとして登録し、パスを NAKO_HOME/src に通す。以下、macOS/Linuxでの.bashrcの記述例。(ユーザー名がkujiraの場合)

```
HOME=/Users/kujira
Expand All @@ -94,7 +102,7 @@ export PATH=$PATH:$NAKO_HOME/src

### コマンドライン版なでしこの利用方法

なでしこのコマンド一覧ファイルを生成するバッチを実行する
例えば、なでしこのコマンド一覧ファイルを生成するバッチを実行する方法

```
$ cnako3 $NAKO_HOME/batch/pickup_command.nako
Expand Down Expand Up @@ -147,12 +155,10 @@ $ npm run build:electron

## Gitからリポジトリを取得して利用する場合

最低限のライブラリで良い場合には、``npm install --production``を実行するだけ。
最低限のライブラリで良い場合には、``npm install --production``を実行するだけ。

```
$ git clnone https://github.com/kujirahand/nadesiko3.git
$ cd nadesiko3
$ npm install --production
```


34 changes: 17 additions & 17 deletions doc/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,29 @@

## 開発目標

-(日本語母語話者を対象とした) 母国語に特化したプログラミング言語
-教育用途に特化
-Webブラウザで手軽に試せること
- (日本語母語話者を対象とした) 母国語に特化したプログラミング言語
- 教育用途に特化
- Webブラウザで手軽に試せること

## どこまでできているのか

-簡単なWebエディタがあり、最小限の文字入力でプログラミングできる
-条件分岐、繰り返しなど、基本的な制御構文が実装されている
- 簡単なWebエディタがあり、最小限の文字入力でプログラミングできる
- 条件分岐、繰り返しなど、基本的な制御構文が実装されている

## 対応機器/Webブラウザ

-HTML5対応ブラウザ (Internet Explorer / Safari / Chrome / Firefox 等)
-スマホブラウザ (iOS Safari / Android標準ブラウザ)
PC (Windows/macOS/Linux - Node.jsが動く環境)
- HTML5対応ブラウザ (Internet Explorer / Safari / Chrome / Firefox 等)
- スマホブラウザ (iOS Safari / Android標準ブラウザ)
- PC (Windows/macOS/Linux - Node.jsが動く環境)

## 今後の開発物の予定

-Web上で本格的なプログラムができるようにする
-動物やキャラクターを動かしたり、お絵かきできるようにする
-ラズパイ上で動かし、電子工作が楽しめるようにする
-ライブラリやAPIなどモジュールを追加する
-教育・プレゼン用途
-グラフの作成
-音を出す
-PC向けバッチ処理ツールとして
-なでしこv1で得たノウハウを、macOS/Linuxでも活用できるようにする
- Web上で本格的なプログラムができるようにする
- 動物やキャラクターを動かしたり、お絵かきできるようにする
- ラズパイ上で動かし、電子工作が楽しめるようにする
- ライブラリやAPIなどモジュールを追加する
- 教育・プレゼン用途
- グラフの作成
- 音を出す
- PC向けバッチ処理ツールとして
- なでしこv1で得たノウハウを、macOS/Linuxでも活用できるようにする
1 change: 1 addition & 0 deletions doc/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ if (typeof (navigator) === 'object') {
}
}
```

例えば、なでしこで管理されている変数「A」にアクセスしたいときは、以下のようなコードを記述する。

```
Expand Down

0 comments on commit 9e4be65

Please sign in to comment.