Skip to content

Commit 82b7345

Browse files
committed
tweak docs
1 parent c433bc3 commit 82b7345

File tree

5 files changed

+27
-32
lines changed

5 files changed

+27
-32
lines changed

README.md

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,10 @@ If you need help or have a question, comment, or suggestion, please feel free to
1818
issue](https://github.com/bloomberg/bucklescript/issues).
1919

2020
## Installing BuckleScript
21-
22-
#### Prerequisites
23-
24-
* Standard C toolchain
25-
* `npm` (should be installed with Node)
26-
27-
#### Installing the Release Package
28-
2921
```
3022
npm install bs-platform
3123
```
32-
33-
#### Installing from Source
34-
35-
```
36-
git clone https://github.com/bloomberg/bucklescript
37-
cd bucklescript
38-
npm install
39-
```
24+
For more advanced settings, please visit [Installation](./site/docsource/Installation.adoc)
4025

4126
The BuckleScript installation includes the following:
4227

@@ -47,13 +32,10 @@ The BuckleScript installation includes the following:
4732
Installing BuckleScript from the npm package places binaries in `./node_modules/.bin`. Installing
4833
from the git repository places them in `./bin`.
4934

50-
## Manually Building BuckleScript
5135

52-
See [Developing BuckleScript](./site/docsource/Developing-bucklescript.md) for detailed instructions on manually building BuckleScript.
36+
## Documentation
5337

54-
## Detailed Documentation
55-
56-
See http://bloomberg.github.io/bucklescript for detailed documentation on BuckleScript. If you'd
38+
See http://bloomberg.github.io/bucklescript/Manual.html for detailed documentation on BuckleScript. If you'd
5739
like to contribute content [see here](https://github.com/bloomberg/bucklescript/blob/master/site/docsource)
5840
for the documentation source.
5941

@@ -193,10 +175,6 @@ function test() {
193175
test();
194176
```
195177

196-
## Release Status
197-
198-
BuckleScript has not reached a stable release. However, it is already quite usable and we
199-
encourage you to try it out and let us know what you think.
200178

201179
## Licensing
202180

docs/Manual.html

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ <h1><a href="https://github.com/bloomberg/bucklescript">BuckleScript</a> User Ma
502502
<ul class="sectlevel2">
503503
<li><a href="#_install_from_npm_registries">Install from NPM registries</a></li>
504504
<li><a href="#_install_from_source_with_npm_package_manager">Install from source with npm package manager</a></li>
505-
<li><a href="#_install_with_minimal_dependencies">Install with minimal dependencies</a></li>
505+
<li><a href="#_install_with_em_minimal_em_dependencies">Install with <em>minimal</em> dependencies</a></li>
506506
<li><a href="#_introduction_to_ocaml_ecosystem_opam">Introduction to OCaml ecosystem: OPAM</a></li>
507507
</ul>
508508
</li>
@@ -783,6 +783,17 @@ <h2 id="_installation"><a class="anchor" href="#_installation"></a>Installation<
783783
<div class="sectionbody">
784784
<div class="sect2">
785785
<h3 id="_install_from_npm_registries"><a class="anchor" href="#_install_from_npm_registries"></a>Install from NPM registries</h3>
786+
<div class="ulist">
787+
<div class="title">Prerequisites</div>
788+
<ul>
789+
<li>
790+
<p>Standard C toolchain</p>
791+
</li>
792+
<li>
793+
<p><code>npm</code> (should be installed with Node)</p>
794+
</li>
795+
</ul>
796+
</div>
786797
<div class="paragraph">
787798
<p>The standard <code>npm</code> package management tool can be used to install
788799
BuckleScript. If you don&#8217;t already have <code>npm</code> installed, follow the
@@ -827,7 +838,7 @@ <h3 id="_install_from_source_with_npm_package_manager"><a class="anchor" href="#
827838
</div>
828839
</div>
829840
<div class="sect2">
830-
<h3 id="_install_with_minimal_dependencies"><a class="anchor" href="#_install_with_minimal_dependencies"></a>Install with minimal dependencies</h3>
841+
<h3 id="_install_with_em_minimal_em_dependencies"><a class="anchor" href="#_install_with_em_minimal_em_dependencies"></a>Install with <em>minimal</em> dependencies</h3>
831842
<div class="olist arabic">
832843
<div class="title">Prerequisites:</div>
833844
<ol class="arabic">
@@ -844,7 +855,7 @@ <h3 id="_install_with_minimal_dependencies"><a class="anchor" href="#_install_wi
844855
<div class="title">Build OCaml compiler</div>
845856
<div class="content">
846857
<pre class="pygments highlight"><code data-lang="sh">git clone --recursive https://github.com/bloomberg/bucklescript
847-
<span class="tok-nb">cd </span>ocaml
858+
<span class="tok-nb">cd </span>bucklescript/ocaml
848859
./configure -prefix <span class="tok-sb">`</span><span class="tok-nb">pwd</span><span class="tok-sb">`</span> <span class="tok-c"># put your preferred directory</span>
849860
make world.opt
850861
make install</code></pre>

docs/js-demo/examples/default.ml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11

2-
Js.log "Hello BuckleScript!"
2+
print_endline "Hello BuckleScript!"
33

docs/js-demo/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ <h3>JavaScript</h2>
9292

9393
<div class = "right-border" style="width: 50%;float:left">
9494
<textarea id="ocamlcode#1">
95-
Js.log "Hello BuckleScript!"
95+
print_endline "Hello BuckleScript!"
9696
</textarea>
9797
</div>
9898
<div style="width: 50%; float:right">

site/docsource/Installation.adoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
### Install from NPM registries
44

5+
6+
.Prerequisites
7+
* Standard C toolchain
8+
* `npm` (should be installed with Node)
9+
10+
511
The standard `npm` package management tool can be used to install
612
BuckleScript. If you don't already have `npm` installed, follow the
713
directions listed
@@ -35,7 +41,7 @@ cd bucklescript
3541
npm install
3642
-----
3743

38-
### Install with minimal dependencies
44+
### Install with _minimal_ dependencies
3945

4046
.Prerequisites:
4147

@@ -52,7 +58,7 @@ easily be done.
5258
[source,sh]
5359
--------------------------------------------------------
5460
git clone --recursive https://github.com/bloomberg/bucklescript
55-
cd ocaml
61+
cd bucklescript/ocaml
5662
./configure -prefix `pwd` # put your preferred directory
5763
make world.opt
5864
make install

0 commit comments

Comments
 (0)