Skip to content

Renaming and fix Starting_your_own_CL #96

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

Merged
AWSwinefred merged 1 commit into from
Feb 20, 2017
Merged

Renaming and fix Starting_your_own_CL #96

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
25 changes: 13 additions & 12 deletions hdk/cl/developer_designs/README.md → ...developer_designs/Starting_Your_Own_CL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
# Starting Your Own Custom Logic (CL)

## Table of Content
1. [Install HDK](#install)
2. [Create new CL Directory and Setup Environment](#setupDir)
3. [Modify Build Scripts](#modifyBuildScripts)

<a name="install"></a>
## 1. Make sure you have the FPGA HDK installed and the environment variables set up

In case you haven't cloned AWS FPGA HDK+SDK, please follow the next steps to download and configure the HDK to the source directory on the instance:

$ git clone https://github.com/aws/aws-fpga
$ cd aws-fpga
$ source hdk_shell.sh
$ source hdk_setup.sh


<a name="setupDir"></a>
## 2. Create a new CL directory, environment variable, and reference directory structure

The developer has two ways to start a new Custom Logic design:

1) Copy one of the example directory from `$HDK_DIR/cl/examples`, and make sure to set up `$CL_DIR` environment variable to point to the new design

2) Setup a new CL directory:
2) Setup a new CL directory from scratch:

$ mkdir Your_New_CL_Directory
$ cd Your_New_CL_Directory
Expand All @@ -29,6 +37,8 @@ In both cases, double-check that the `$CL_DIR` is set correctly by calling and c

$ echo $CL_DIR


<a name="modifyBuildScripts"></a>
## 3. Modify the build scripts

The following scripts should be modified before starting the build:
Expand All @@ -39,16 +49,7 @@ The following scripts should be modified before starting the build:
Once your design is ready and you would like to start the build/create process, please refer to this [checklist](../CHECKLIST_BEFORE_BUILDING_CL.md).


**NOTE**: *The DCP generation can take up to several hours to complete.
We recommend that you initiate the generation in a way that prevents interruption.
For example, if working on a remote machine, we recommend using window management tools such as [`screen`](https://www.gnu.org/software/screen/manual/screen.html) to mitigate potential network disconnects.*


Once you verified the checklist, you can run:

$ ./aws_build_dcp_from_cl.tcl

**NOTE** *A detailed walkthrough on how to build the CL is also available in `$CL_DIR/build/scripts/README.md`.*
Once you verified the checklist, the detailed walkthrough on how to build and submit the CL to AWS is avaiable [here](../../common/shell_current/new_cl_template/build/README.md)