Skip to content

Commit 0bd1cf4

Browse files
committed
Reorganize, change repo name to onepagers
1 parent f7815b9 commit 0bd1cf4

File tree

2 files changed

+37
-51
lines changed

2 files changed

+37
-51
lines changed

README.md

Lines changed: 37 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,34 @@
11
# What is this:
22

3-
This is a single page repo showing how to integrate a model with a view.
3+
Hey, welcome!
44

5-
It uses a new approach for drawing a model in the AS tests/ dir:
5+
This is a collection of one page AgemtScript models along with their views and additional tools from the [AgentScript repo](https://github.com/backspaces/agentscript).
66

7-
import TwoDraw from 'https://backspaces.github.io/agentscript/tests/TwoDraw.js'
7+
Here's the onepagers repo: [https://github.com/backspaces/onepager](https://github.com/backspaces/onepager)
88

9-
It works by creating a properties object describing how to "draw" the model.
9+
## Here's how to start a git project, like this one:
1010

11-
It is very experimental and it is showing me lots of issues. That's what this is all about, right?
12-
13-
See the repo: https://github.com/backspaces/virus
14-
15-
Run the model using TwoView: https://backspaces.github.io/virus/
16-
17-
Add any queryString to use TwoDraw: https://backspaces.github.io/virus/?foo
18-
19-
# Init:
20-
21-
- cd ~/src
22-
- mkdir virus
23-
- cd virus
24-
- code .
25-
- touch README.md
26-
27-
Then
28-
29-
- copy/modify VirusModel.js index.html from AS;
30-
- server.js from Josh
31-
32-
Files are:
33-
34-
- VirusModel.js: From agentscript/models, imports modified
35-
- index.html: Imports VirusModel, creates View & Draw options for run()
36-
- runModel.js: An async runner: run(ModelClass, ViewOptions, DrawOptions)
37-
38-
Also:
11+
```
12+
cd ~/src
13+
mkdir onepagers
14+
cd onepagers
15+
touch README.md
16+
copy/install a server for locally testing.
17+
```
3918

40-
- README.md // this file
41-
- server.js // Josh's http server
19+
I grabbed a very simple & readable, server.js, from Redfish. You can copy it from the onepagers repo.
4220

43-
Run via:
21+
Run it via:
4422

45-
- node < server.js &
46-
- browser: http://localhost:9000/virus.html .. or whatever page you wan
47-
- Open console for debug info
23+
```
24+
node < server.js &
25+
browser: http://localhost:9000/\<my model\>.html
26+
Open console for debug info
27+
```
4828

49-
# Workflow:
29+
## Workflow:
5030

51-
Turn into git repo:
31+
Turn your directory into git repo:
5232

5333
```
5434
git init
@@ -66,22 +46,28 @@ git add .
6646
git commit -m "first commit"
6747
```
6848

69-
Integrate with github:
49+
## Integrate with github:
50+
51+
Go to your github account, for me https://github.com/backspaces/
52+
53+
Use the + button to add a new repo in my case onepagers. This creates [https://github.com/backspaces/onepagers](https://github.com/backspaces/onepagers)
54+
55+
Connect your local git repo with github:
7056

7157
```
72-
https://github.com/backspaces/
73-
+: new repository .. virus
74-
https://github.com/backspaces/virus
75-
git remote add origin https://github.com/backspaces/virus.git
58+
git remote add origin https://github.com/backspaces/onepagers.git
7659
git push -u origin master
77-
<create ghpage in master>
78-
https://github.com/backspaces/virus/settings
79-
scroll down to GitHub Pages, source: master, theme:
80-
to get page metadata locally:
81-
git pull origin master
8260
```
8361

84-
See it here: https://backspaces.github.io/virus/
62+
Make your repo also a github page: go to: https://github.com/backspaces/onepagers/settings
63+
64+
scroll down to GitHub Pages, source: master, theme: set to one you like
65+
66+
Then to get page metadata locally:
67+
68+
git pull origin master
69+
70+
See it here: [https://backspaces.github.io/onepagers/](https://backspaces.github.io/onepagers/)
8571

8672
Rinse and repeat:
8773

index.html renamed to virus.html

File renamed without changes.

0 commit comments

Comments
 (0)