Skip to content

Commit b4134fa

Browse files
author
Sven Van Caekenberghe
committed
reorg README
1 parent 6d23bc5 commit b4134fa

File tree

2 files changed

+64
-27
lines changed

2 files changed

+64
-27
lines changed

README-gemstone.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Zinc HTTP Components
2+
3+
## For GemStone
4+
5+
6+
Zinc HTTP Components is an open-source Smalltalk framework
7+
to deal with the HTTP networking protocol.
8+
9+
10+
Base [Readme](README.md)
11+
12+
13+
## Loading into GemStone
14+
15+
1. [Upgrade to GLASS 1.0-beta.9](http://code.google.com/p/glassdb/wiki/GemToolsUpdate#Update_GLASS)
16+
17+
2. Install Zinc:
18+
19+
```Smalltalk
20+
"GemStone 2.4"
21+
Metacello new
22+
baseline: 'Zinc';
23+
repository: 'github://glassdb/zinc:gemstone2.4/repository';
24+
load: 'Tests'.
25+
26+
"GemStone 3.1"
27+
Metacello new
28+
baseline: 'Zinc';
29+
repository: 'github://glassdb/zinc:gemstone3.1/repository';
30+
load: 'Tests'.
31+
```
32+
33+
*See the [Releases page](https://github.com/glassdb/zinc/releases/) for instructions for installing specific Zinc releases.*
34+
35+
## Travis Status
36+
37+
**GemStone2.4.x** [![Build Status](https://travis-ci.org/glassdb/zinc.png?branch=gemstone2.4)](https://travis-ci.org/glassdb/zinc)
38+
39+
**GemStone3.1.x** [![Build Status](https://travis-ci.org/glassdb/zinc.png?branch=gemstone3.1)](https://travis-ci.org/glassdb/zinc)

README.md

+25-27
Original file line numberDiff line numberDiff line change
@@ -4,49 +4,47 @@
44
Zinc HTTP Components is an open-source Smalltalk framework
55
to deal with the HTTP networking protocol.
66

7-
8-
<http://zn.stfx.eu>
7+
[![Build Status](https://travis-ci.org/svenvc/zinc.svg?branch=master)](https://travis-ci.org/svenvc/zinc)
98

109

11-
[![Build Status](https://travis-ci.org/svenvc/zinc.svg?branch=master)](https://travis-ci.org/svenvc/zinc)
10+
Based on core classes modelling all main HTTP concepts, a full featured HTTP client and server are provided.
1211

1312

1413
## Documentation
1514

16-
The [Zinc HTTP Components](zinc-http-components-paper.md) paper.
1715

18-
The [Building and deploying your first web app with Pharo](build-and-deploy-1st-webapp/build-deploy-1st-webapp.md) tutorial.
16+
Over the years, various documentation has been written about Zinc HTTP Components.
17+
Some of it is somewhat outdated. We list the most recent first.
1918

19+
The code base has decent class and method comments, as well as unit tests and examples.
2020

21-
*Sven Van Caekenberghe*
21+
The best starter documentation can be found in the
22+
[Pharo Enterprise](http://books.pharo.org/enterprise-pharo/) book.
2223

24+
In particular, in the following chapters:
25+
- [Client](https://ci.inria.fr/pharo-contribution/job/EnterprisePharoBook/lastSuccessfulBuild/artifact/book-result/Zinc-HTTP-Client/Zinc-HTTP-Client.html)
26+
- [Server](https://ci.inria.fr/pharo-contribution/job/EnterprisePharoBook/lastSuccessfulBuild/artifact/book-result/Zinc-HTTP-Server/Zinc-HTTP-Server.html)
27+
- [WebApp](https://ci.inria.fr/pharo-contribution/job/EnterprisePharoBook/lastSuccessfulBuild/artifact/book-result/WebApp/WebApp.html)
28+
- [TeaPot](https://ci.inria.fr/pharo-contribution/job/EnterprisePharoBook/lastSuccessfulBuild/artifact/book-result/Teapot/Teapot.html)
29+
- [Encoding](https://ci.inria.fr/pharo-contribution/job/EnterprisePharoBook/lastSuccessfulBuild/artifact/book-result/Zinc-Encoding-Meta/Zinc-Encoding-Meta.html)
2330

24-
[MIT Licensed](https://github.com/svenvc/zinc/blob/master/license.txt)
31+
A live website can be found at [http://zn.stfx.eu](http://zn.stfx.eu). You can run part of this website locally.
2532

26-
## Loading into GemStone
33+
The original [Zinc HTTP Components](zinc-http-components-paper.md) paper.
2734

28-
1. [Upgrade to GLASS 1.0-beta.9](http://code.google.com/p/glassdb/wiki/GemToolsUpdate#Update_GLASS)
35+
The [Building and deploying your first web app with Pharo](build-and-deploy-1st-webapp/build-deploy-1st-webapp.md) tutorial.
2936

30-
2. Install Zinc:
3137

32-
```Smalltalk
33-
"GemStone 2.4"
34-
Metacello new
35-
baseline: 'Zinc';
36-
repository: 'github://glassdb/zinc:gemstone2.4/repository';
37-
load: 'Tests'.
38-
39-
"GemStone 3.1"
40-
Metacello new
41-
baseline: 'Zinc';
42-
repository: 'github://glassdb/zinc:gemstone3.1/repository';
43-
load: 'Tests'.
44-
```
38+
## Loading
4539

46-
*See the [Releases page](https://github.com/glassdb/zinc/releases/) for instructions for installing specific Zinc releases.*
40+
```Smalltalk
41+
Metacello new
42+
repository: 'github://svenvc/zinc/repository';
43+
baseline: 'ZincHTTPComponents';
44+
load.
45+
```
4746

48-
## Travis Status
4947

50-
**GemStone2.4.x** [![Build Status](https://travis-ci.org/glassdb/zinc.png?branch=gemstone2.4)](https://travis-ci.org/glassdb/zinc)
48+
*Sven Van Caekenberghe*
5149

52-
**GemStone3.1.x** [![Build Status](https://travis-ci.org/glassdb/zinc.png?branch=gemstone3.1)](https://travis-ci.org/glassdb/zinc)
50+
[MIT Licensed](https://github.com/svenvc/zinc/blob/master/license.txt)

0 commit comments

Comments
 (0)