Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

electrostatic-sandbox-framework/README.md: HSS patch #10

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

electrostatic-sandbox-framework/README.md: HSS patch #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 31 additions & 11 deletions electrostatic-sandbox-framework/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,35 @@ This framework has 2 environments and provides binaries for 2 devices:
- The main board.
- The externally pluggable modular boards.

## Dependencies
### Communications:
- [Serial4j](https://github.com/Electrostat-Lab/Serial4j)
- [ShiftAvr](https://github.com/Electrostat-Lab/ShiftAvr)
- [Parallel4j]()
- [Socket4j]()

### Architecture:
- [Articular-ES](https://github.com/Electrostat-Lab/Articular-ES)
- [Automata4j](https://github.com/Electrostat-Lab/Automata4j)
- [Jector](https://github.com/Electrostat-Lab/Jector)
## Hardware-Software Specification:

| **Item** | **Explanation** |
|--------|---------------|
| _Problem Definition_ | |
| _Scientific Recall of the problem_ | |
| _General Approach_ | |
| _Specialized Approach_ | |
| _Scientific Approach_ | |
| _The Framework components_ | |

## The framework parts:
**The Native Electrostatic API**
- electrostatic-core: provides the core of the electrostatic framework written purely in C.
- electrostatic-examples: provides direct examples in the form of executables for the core API.

**The Java Binding API (Electrostatic4j aka. _e4j_)**
- electrostatic4j-core: the core Java binding API, containing the native image loader and the binding Java side of the glue code.
- electrostatic4j-native: the native Java binding API, containing the glue code written purely in C.
- electrostatic4j-examples: implicit examples for the electrostatic API through the Java binding API.
- electrostatic4j-android: android glue code (not planned!).

## Building the framework:
- [x] Building the `electrostatic-core` module into a static and a dynamic library:

- [x] Building the `electrostatic-examples` module into an executable and linking with the `electrostatic-core` binaries:

- [x] Building the `electrostatic4j` library and runtime linking:

- [x] Running the `electrostatic4j-examples` examples: