Skip to content

Commit deff853

Browse files
committed
Initial release commit
0 parents  commit deff853

File tree

222 files changed

+28844
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

222 files changed

+28844
-0
lines changed

.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "soc"]
2+
path = soc
3+
url = https://github.com/os-cillation/easyfpga-soc.git

COPYING

+675
Large diffs are not rendered by default.

README.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# easyfpga-sdk-cpp
2+
This is the easyFPGA software development kit for C++. You want to take
3+
advantage of configurable hardware and avoid the effort of becoming
4+
acquainted with hardware description languages? Then easyFPGA
5+
is exactly what you are looking for! It will highly simplify your way to
6+
success the design of FPGA-based systems.
7+
8+
The "easyFPGA toolkit" is an open source project consisting of:
9+
- an easyFPGA development board and
10+
- an C++-SDK (called framework).
11+
12+
The easyFPGA framework allows you accessing different hardware components
13+
within your C++ applications and is currenty meant to be used in
14+
conjunction with the easyFPGA board. The SDK is licensed as open source
15+
and can be arbitrarily modified for an non-commercial use, why it can be
16+
freely customized to run with self-selected hardware. Only if you intend
17+
to use it commercially, please request for an alternative license model
18+
with the contact form can be found on http://easyfpga.de.
19+
20+
You can find detailed information on how to install and use the SDK in
21+
the documentation.
22+
23+
## Cloning
24+
In order to get the SDK please clone this repository. Since there is the
25+
submodule soc already included in this repository containing all
26+
neccessary hardware description files for generating FPGA binaries, you
27+
have to clone it recursively:
28+
29+
```
30+
$ git clone --recursive https://github.com/os-cillation/easyfpga-sdk-cpp.git
31+
```
32+
33+
## Documentation
34+
The documentation is included into the source files and contains all
35+
information about the SDK you need. You are able to generate a html
36+
documentation for example using doxygen. For that, please make sure you
37+
have installed the package doxygen on your system.
38+
39+
```
40+
$ cd easyfpga-sdk-cpp/sdk
41+
$ make doc
42+
```
43+
44+
Then use your favorite webbrowser to read the generated documentation:
45+
46+
```
47+
$ WEBBROSWER sdk/doc/html/index.html
48+
```
49+
50+
## Changelog
51+
52+
#### v1.0 (2015-09-14)
53+
* Initial check-in

sdk/.gitignore

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# output directories
2+
/doc/
3+
/bin/
4+
/lib/
5+
/testoutput/
6+
7+
# ignore testcase generated files
8+
src/*/*/test/*/*.vhd
9+
src/*/*/test/*/*.bin
10+
src/*/*/test/*/*.log
11+
12+
src/*/*/test/*.vhd
13+
src/*/*/test/*.bin
14+
src/*/*/test/*.log
15+
16+
src/*/test/*.vhd
17+
src/*/test/*.bin
18+
src/*/test/*.log

0 commit comments

Comments
 (0)