README

   1 apeos is a project with goal of providing text shell and server (as in
   2 socket bind()) experience on esp-32.
   3
   4 apeos is a portmanteau of ape, a class of animal species humans are
   5 part of, and os, for operating system. Whether one can write like Shak
   6 on apeos probably depends on whether shis tail can be easily hidden
   7 with a dress :)
   8
   9 Building
  10 ========
  11
  12 Have esp-idf v3.0 (git commit 6698be57c80eaa968aca40d12d17479c06e75ae8)
  13 setup. This prerequisite also brings xtensa-32 gcc toolchain.
  14
  15 The build process uses GNU make.
  16
  17 Build everything:
  18
  19 make
  20
  21 If host machine has more than one CPU (in single socket or not),
  22 supply -j option to make. E.g. "make -j4" to use four CPU cores.
  23
  24 Flash the built binary to esp-32 flash storage:
  25
  26 make flash
  27
  28 Attach terminal emulator to UART0:
  29
  30 make monitor
  31
  32 Alternatively, use the cu program [1] or similar program for
  33 attaching terminal emulator to UART0.
  34
  35 The project use of esptool_py is currently configured for
  36 /dev/ttyUSB0 device of usb-to-serial module that connects to UART0.
  37
  38 [1] a port of openbsd cu(1) to Linux: http://github.com/nedko/cu.git