git @ Cat's Eye Technologies The-Platform / 44725dc
Even more usage information. Chris Pressey 10 years ago
1 changed file(s) with 86 addition(s) and 16 deletion(s). Raw diff Collapse all Expand all
+86
-16
USAGE.markdown less more
00 Using The Cat's Eye Technologies Platform
11 =========================================
22
3 The Cat's Eye Technologies Platform (version 0.2) is a bootable NetBSD-based
4 disk image containing almost all of [Cat's Eye Technologies](http://catseye.tc/)'
5 software distributions, pre-built and tested, and the infrastructure needed to
6 run them.
3 The Cat's Eye Technologies Platform (version 0.2) is a bootable [NetBSD][]-based
4 disk image containing almost all of [Cat's Eye Technologies][]' software
5 distributions, pre-built and tested, and the infrastructure needed to run them.
76
87 For more information, and more up-to-date information, on The Platform, see
98
10 * [https://github.com/catseye/The-Platform](https://github.com/catseye/The-Platform)
9 * [https://github.com/catseye/The-Platform][]
10
11 [NetBSD]: http://netbsd.org/
12 [Cat's Eye Technologies]: http://catseye.tc/
13 [https://github.com/catseye/The-Platform]: https://github.com/catseye/The-Platform
1114
1215 ...on Windows
1316 -------------
17
18 ### How to extract the disk image ###
19
20 The disk image is compressed using 7-zip. You can download 7-zip here:
21
22 http://www.7-zip.org/
23
24 Note that while the compressed archive is "only" ~200M, the uncompressed disk
25 image is 3.6 gigabytes. So make sure you have sufficient space before
26 extracting it.
1427
1528 ### How to boot the image in the QEMU PC emulator ###
1629
3649
3750 ...all on one line, and don't forget the double quotes.
3851
52 You should see NetBSD boot up in the QEMU window. Now see
53 _Logging in and using The Platform_, below.
54
3955 ### How to boot the image in the Bochs PC emulator ###
4056
4157 **Note**: Bochs has problems sending keystrokes to NetBSD, so using it
6278 load it again.
6379
6480 Then click "Start".
81
82 You should see NetBSD boot up in the Bochs window. Now see
83 _Logging in and using The Platform_, below.
6584
6685 ### How to make a bootable USB stick of The Platform ###
6786
85104
86105 When you're sure you've got the drive letter right, click "Write". And wait.
87106
88 For using the USB stick after you've written it, see below.
107 For using the USB stick after you've written it, see
108 _Booting from a created USB stick_ below.
89109
90110 ...on Ubuntu (Linux)
91111 --------------------
92112
113 To extract the disk image, use `p7zip`:
114
115 sudo apt-get install p7zip
116 p7zip -d The-Cats-Eye-Technologies-Platform-0.2.img.7z
117
93118 To boot the disk image under the QEMU emulator,
94119
95120 sudo apt-get install qemu
96121 qemu-system-i386 The-Cats-Eye-Technologies-Platform-0.2.img
97122
123 You should see NetBSD boot up in the QEMU window. Now see
124 _Logging in and using The Platform_, below.
125
98126 To write the disk image to a USB stick,
99127
100128 dd if=The-Cats-Eye-Technologies-Platform-0.2.img of=/dev/sdX bs=1M
102130 where `sdX` is the name of your (unmounted) USB device (could be `sdb` or
103131 `sdc`; check `mount` while the device is still mounted.)
104132
105 Using the USB stick after you've written it
106 -------------------------------------------
107
108 **Note**: The instructions in this section have not been thoroughly tested.
109
110 Turn off your computer. Plug the USB stick into a USB port. Turn on your
133 For using the USB stick after you've written it, see
134 _Booting from a created USB stick_ below.
135
136 Booting from a created USB stick
137 --------------------------------
138
139 Shut down your computer. Plug the USB stick into a USB port. Turn on your
111140 computer.
112141
113142 If your computer displays `NetBSD/x86 BIOS Boot` and a numbered menu with
115144
116145 If it didn't, restart your computer and go into its BIOS configuration
117146 (how you do this differs from computer to computer, but it's usually a
118 matter of hitting a key (maybe F1, maybe Escape, maybe something else)
119 right after it boots up.
147 matter of hitting a key -- maybe F1, maybe Escape, maybe something else --
148 right after it boots up.)
120149
121150 Here are some things to check:
122151
139168
140169 mount /dev/sd0a /
141170
142 And then
171 (note that there is a space before that last `\`.) And then
143172
144173 /home/user/toolshelf/bitbucket.org/catseye/ee/ee /etc/fstab
145174
154183 reboot
155184
156185 and this time, when the system boots into NetBSD, it will not give you
157 this error and it will let you log into it normally, as `user`.
186 this error and it will let you log into it normally.
187
188 Logging in and using The Platform
189 ---------------------------------
190
191 First, note that, when running, The Platform does *not* have access to your
192 hard drive (outside of its own disk image file) and does *not* have access
193 to your network. This is intentional; it means that you can muck around
194 however you like inside The Platform and it should not affect (or be affected)
195 by anything outside.
196
197 Second, note that any changes you do make inside The Platform -- for example,
198 files you change, or new files you write -- will be saved to the disk image
199 file. If you keep the archived `.7z` file you can always extract a fresh
200 copy of the disk image file from that, if you want to start over.
201
202 Now. To log in, log in as `user`. There is no password. You will get a
203 `$` prompt at which you can type commands. (This is called the "shell".)
204
205 To shut down The Platform, type
206
207 su
208
209 (and the prompt will change to a `#` to indicate that you now have Super
210 User powers), then type
211
212 shutdown -p now
213
214 You can also just close the emulator, or power off the computer, but these
215 actions risk corrupting the disk image (but as we said, you can always just
216 start over, so this is not a huge deal.)
217
218 While logged in, most of Cat's Eye Technologies' programming language
219 interpreters and compilers can be started just by typing their name
220 (in Unix-speak, these executables are on the search path.) For example,
221 type `maentw` to start the Maentwrog interpreter. (Type `bye` to exit.)
222
223 You can also use `toolshelf` to navigate to the language project directories,
224 and run tests. The short alias is `th`. So, for example,
225
226 th cd befunge-93
227 th test nhohnhehr