Skip to content

Commit 8dd8ebb

Browse files
Update README
1 parent d770682 commit 8dd8ebb

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,30 @@
22

33
# ng-objects
44

5-
ng-objects is an open source web framework hevaily based on the concepts found in Apple's WebObjects (WO) framework. It aims to:
5+
ng-objects is an open source web framework heavily based on concepts from Apple's WebObjects (WO) framework. It aims to:
66

7-
1. Extract the best concepts of WO and use them in a new, modern library.
7+
1. Extract the best concepts of WO and project Wonder (including the Ajax-framework, for client side interaction) and use them in a new, modern library.
88

99
2. Not be a WO clone but _familiar_ to a WO programmer and thus easy to migrate existing WO code to. While WO is great, there have been two decades of improvements in software design and web development since WO's last official release.
1010

11-
3. Be compatible with WO's deployment environment, so apps can transparently integrate into an existing WO based deployment infrastructure.
11+
3. Be compatible with WO's deployment environment, so apps can transparently integrate into an existing WO deployment infrastructure, easing transition of existing apps and environments.
1212

13-
## Launching the test application
13+
## Status
1414

15-
### Install dependencies/frameworks
15+
The framework is still in development, but we currently have working implementations of HTTP request handling, templating, very, very basic routing, resource management, property management, sessions, and stateful actions.
1616

17-
1. Clone this repo.
18-
2. Run `mvn install` at the project's root.
17+
"Working implementation" is doing a lot of heavy lifting in that sentence though, since we're now going through the process of cleaning up and enriching the API and making it a joy to use. And there's a lot of work to do there. But first release is scheduled for 2025.
1918

20-
### Build and launch `ng-testapp`
21-
Build and run the application:
19+
## Trying the test application
2220

23-
1. `cd ng-testapp`
24-
2. `mvn package`
25-
3. `./target/ng-testapp-1.0.0-SNAPSHOT.woa/ng-testapp`
21+
We haven't made a release yet, so to try the framework you need to either clone the repo and either import the projects into your IDE and run the "Application" class in the ng-testapp project, or, using maven on the command line...
2622

27-
Now point your browser to [localhost:1200](http://localhost:1200/). You should be greeted with a test page showing some of the current features. Congratulations!
23+
```
24+
$ git clone git@github.com:ngobjects/ng-objects.git
25+
$ mvn install
26+
$ cd ng-testapp
27+
$ mvn package
28+
$ ./target/ng-testapp-1.0.0-SNAPSHOT.woa/ng-testapp
29+
```
30+
31+
Then point your browser to [localhost:1200](http://localhost:1200/). Yay!

0 commit comments

Comments
 (0)