Просмотр исходного кода

README: 'use as library' instructions

Herbert Vojčík 9 лет назад
Родитель
Сommit
b7619f3464
1 измененных файлов с 23 добавлено и 0 удалено
  1. 23 0
      root/README.md

+ 23 - 0
root/README.md

@@ -4,6 +4,29 @@
 
 ## Getting Started
 
+Install Amber and create an Amber project,
+as shown in [Amber Instructions](https://github.com/amber-smalltalk/amber#prerequisites).
+
+## Use {%= name %} as a library in a client project
+
+If not already present, create a client project
+in an empty directory with `amber init`.
+
+In a client project, run
+
+```sh
+bower install {%= name %} --save
+grunt devel
+amber serve
+```
+
+Go to `http://localhost:4000/` in your browser and
+in all packages that use {%= name %},
+add `'{%= namespace %}/{%= name %}'` to the package imports,
+save the change and commit the package. Reload.
+
+## Contributing
+
 To bring project alive (for example after `git clone`):
 
 ```sh