Commit bb73d3bc authored by Ishan Kumar Kaler's avatar Ishan Kumar Kaler
Browse files

update the README

parent cff0dde0
......@@ -5,7 +5,7 @@ process_begin: CreateProcess(NULL, cc -dumpmachine, ...) failed.
pd-lib-builder//Makefile.pdlibbuilder:473: pipe: No such file or directory
process_begin: CreateProcess(NULL, uname, ...) failed.
pd-lib-builder//Makefile.pdlibbuilder:526: pipe: No such file or directory
pd-lib-builder//Makefile.pdlibbuilder:760: *** Command "cc -dumpmachine" did not return a target triplet, needed for a build. Is compiler "cc" installed in your PATH? (C:\Program Files (x86)\VMware\VMware Player\bin\;C:\Program Files\Amazon Corretto\jdk1.8.0_312\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\WINDOWS\System32\OpenSSH\;C:\Program Files\NVIDIA Corporation\NVIDIA NvDLISR;C:\Program Files (x86)\NVIDIA Corporation\PhysX\Common;C:\Program Files\CMake\bin;C:\ProgramData\chocolatey\bin;C:\Users\kumar\AppData\Roaming\nvm;C:\Program Files\nodejs;C:\Program Files\Amazon Corretto\jdk1.8.0_312;C:\Program Files\Amazon Corretto\;C:\Program Files\dotnet\;C:\Users\kumar\AppData\Local\Programs\Python\Python310\Scripts;C:\Program Files\Git\cmd;C:\MinGW\bin;;C:\Program Files\Docker\Docker\resources\bin;C:\ProgramData\DockerDesktop\version-bin;C:\Users\kumar\.cargo\bin;C:\Program Files\Amazon Corretto\jdk1.8.0_312\bin;C:\Users\kumar\AppData\Local\Programs\Microsoft VS Code\bin;C:\Users\kumar\AppData\Local\Programs\Python\Python310\Scripts;C:\MinGW\bin;). Does compiler "cc" support option "-dumpmachine"?. Stop.
pd-lib-builder//Makefile.pdlibbuilder:760: *** Command "cc -dumpmachine" did not return a target triplet, needed for a build. Is compiler "cc" installed in your PATH? (C:\Program Files (x86)\VMware\VMware Player\bin\;C:\Program Files\Amazon Corretto\jdk1.8.0_312\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\WINDOWS\System32\OpenSSH\;C:\Program Files\NVIDIA Corporation\NVIDIA NvDLISR;C:\Program Files (x86)\NVIDIA Corporation\PhysX\Common;C:\Program Files\CMake\bin;C:\ProgramData\chocolatey\bin;C:\Users\kumar\AppData\Roaming\nvm;C:\Program Files\nodejs;C:\Program Files\Amazon Corretto\jdk1.8.0_312;C:\Program Files\Amazon Corretto\;C:\Program Files\dotnet\;C:\Users\kumar\AppData\Local\Programs\Python\Python310\Scripts;C:\MinGW\bin;C:\Program Files\Docker\Docker\resources\bin;C:\ProgramData\DockerDesktop\version-bin;C:\Program Files\Git\cmd;C:\Users\kumar\.cargo\bin;C:\Program Files\Amazon Corretto\jdk1.8.0_312\bin;C:\Users\kumar\AppData\Local\Programs\Microsoft VS Code\bin;C:\Users\kumar\AppData\Local\Programs\Python\Python310\Scripts;C:\MinGW\bin;). Does compiler "cc" support option "-dumpmachine"?. Stop.
++++ info: using Makefile.pdlibbuilder version 0.6.0
make: Leaving directory 'c:/msys64/home/kumar/gsoc/lib-data-over-audio'
......
{
"makefile.extensionOutputFolder": "./.vscode"
"makefile.extensionOutputFolder": "./.vscode",
"files.associations": {
"stdlib.h": "c"
}
}
\ No newline at end of file
make.exe all --print-data-base --no-builtin-variables --no-builtin-rules --question
process_begin: CreateProcess(NULL, -dumpmachine, ...) failed.
pd-lib-builder//Makefile.pdlibbuilder:473: pipe: No such file or directory
process_begin: CreateProcess(NULL, uname, ...) failed.
pd-lib-builder//Makefile.pdlibbuilder:526: pipe: No such file or directory
pd-lib-builder//Makefile.pdlibbuilder:760: *** Command " -dumpmachine" did not return a target triplet, needed for a build. Is compiler "" installed in your PATH? (C:\Program Files (x86)\VMware\VMware Player\bin\;C:\Program Files\Amazon Corretto\jdk1.8.0_312\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\WINDOWS\System32\OpenSSH\;C:\Program Files\NVIDIA Corporation\NVIDIA NvDLISR;C:\Program Files (x86)\NVIDIA Corporation\PhysX\Common;C:\Program Files\CMake\bin;C:\ProgramData\chocolatey\bin;C:\Users\kumar\AppData\Roaming\nvm;C:\Program Files\nodejs;C:\Program Files\Amazon Corretto\jdk1.8.0_312;C:\Program Files\Amazon Corretto\;C:\Program Files\dotnet\;C:\Users\kumar\AppData\Local\Programs\Python\Python310\Scripts;C:\Program Files\Git\cmd;C:\MinGW\bin;;C:\Program Files\Docker\Docker\resources\bin;C:\ProgramData\DockerDesktop\version-bin;C:\Users\kumar\.cargo\bin;C:\Program Files\Amazon Corretto\jdk1.8.0_312\bin;C:\Users\kumar\AppData\Local\Programs\Microsoft VS Code\bin;C:\Users\kumar\AppData\Local\Programs\Python\Python310\Scripts;C:\MinGW\bin;). Does compiler "" support option "-dumpmachine"?. Stop.
pd-lib-builder//Makefile.pdlibbuilder:760: *** Command " -dumpmachine" did not return a target triplet, needed for a build. Is compiler "" installed in your PATH? (C:\Program Files (x86)\VMware\VMware Player\bin\;C:\Program Files\Amazon Corretto\jdk1.8.0_312\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\WINDOWS\System32\OpenSSH\;C:\Program Files\NVIDIA Corporation\NVIDIA NvDLISR;C:\Program Files (x86)\NVIDIA Corporation\PhysX\Common;C:\Program Files\CMake\bin;C:\ProgramData\chocolatey\bin;C:\Users\kumar\AppData\Roaming\nvm;C:\Program Files\nodejs;C:\Program Files\Amazon Corretto\jdk1.8.0_312;C:\Program Files\Amazon Corretto\;C:\Program Files\dotnet\;C:\Users\kumar\AppData\Local\Programs\Python\Python310\Scripts;C:\MinGW\bin;C:\Program Files\Docker\Docker\resources\bin;C:\ProgramData\DockerDesktop\version-bin;C:\Program Files\Git\cmd;C:\Users\kumar\.cargo\bin;C:\Program Files\Amazon Corretto\jdk1.8.0_312\bin;C:\Users\kumar\AppData\Local\Programs\Microsoft VS Code\bin;C:\Users\kumar\AppData\Local\Programs\Python\Python310\Scripts;C:\MinGW\bin;). Does compiler "" support option "-dumpmachine"?. Stop.
++++ info: using Makefile.pdlibbuilder version 0.6.0
# GNU Make 4.3
......@@ -13,7 +14,7 @@ pd-lib-builder//Makefile.pdlibbuilder:760: *** Command " -dumpmachine" did not r
# This is free software: you are free to change and redistribute it.
# There is NO WARRANTY, to the extent permitted by law.
# Make data base, printed on Thu Jul 14 12:27:39 2022
# Make data base, printed on Thu Jul 21 13:57:48 2022
# Variables
......@@ -60,13 +61,13 @@ datafiles =
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 728)
c.ldlibs := $(subst ,, )
# environment
CHROME_CRASHPAD_PIPE_NAME = \\.\pipe\crashpad_24284_EVYYVCLYXHJUBTIZ
CHROME_CRASHPAD_PIPE_NAME = \\.\pipe\crashpad_36412_MJDZYVKWELXASMIU
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 731)
cxx.flags := -DPD -I "" -Wall -Wextra -Wshadow -Winline -Wstrict-aliasing -O3 -ffast-math -funroll-loops -fomit-frame-pointer
# environment
VSCODE_HANDLES_UNCAUGHT_ERRORS = true
# default
.VARIABLES := SYSTEMDRIVE JAVA_HOME LC_ALL ACSVCPORT USERPROFILE VBOX_MSI_INSTALL_PATH LOCALAPPDATA VSCODE_CWD CHOCOLATEYINSTALL SYSTEMROOT PROCESSOR_LEVEL PSMODULEPATH MAKE_COMMAND datafiles @D CHROME_CRASHPAD_PIPE_NAME VSCODE_HANDLES_UNCAUGHT_ERRORS .VARIABLES %D ^D %F VSCODE_CODE_CACHE_PATH LANG .LOADED TMP .INCLUDE_DIRS PROCESSOR_ARCHITEW6432 MAKEFLAGS ONEDRIVE CURDIR APPLICATION_INSIGHTS_NO_DIAGNOSTIC_CHANNEL *D PROGRAMFILES WALLABY_PRODUCTION MFLAGS .SHELLFLAGS COMMONPROGRAMW6432 +D lib.name MAKEFILE_LIST @F VSCODE_PID ?D *F <D BUILDLABEX VSCODE_NLS_CONFIG MAKE_HOST PROGRAMDATA SHELL CLASSPATH version HOMEPATH MAKECMDGOALS DRIVERDATA COMSPEC WINDIR MAKELEVEL MAKE PATH COMPUTERNAME MAKEFILES ^F PROMPT PDLIBBUILDER_DIR CHOCOLATEYLASTPATHUPDATE LOGONSERVER USERNAME COMMONPROGRAMFILES ?F PROGRAMW6432 encoder.class.sources PATHEXT class.sources +F ORIGINAL_XDG_CURRENT_DESKTOP metafile USERDOMAIN GNUMAKEFLAGS OS add-class-source __COMPAT_LAYER .DEFAULT_GOAL NVM_HOME MAKE_VERSION PROGRAMFILES(X86) USERDOMAIN_ROAMINGPROFILE NUMBER_OF_PROCESSORS externalsdir PUBLIC BUILDLAB APPDATA HOMEDRIVE NVM_SYMLINK decoder.class.sources PROCESSOR_ARCHITECTURE VSCODE_AMD_ENTRYPOINT COMMONPROGRAMFILES(X86) ELECTRON_RUN_AS_NODE TEMP VSCODE_IPC_HOOK .RECIPEPREFIX <F SUFFIXES ALLUSERSPROFILE SESSIONNAME .FEATURES PROCESSOR_REVISION Makefile.pdlibbuilder PROCESSOR_IDENTIFIER JRE_HOME
.VARIABLES := SYSTEMDRIVE JAVA_HOME LC_ALL ACSVCPORT USERPROFILE VBOX_MSI_INSTALL_PATH LOCALAPPDATA VSCODE_CWD CHOCOLATEYINSTALL SYSTEMROOT PROCESSOR_LEVEL PSMODULEPATH MAKE_COMMAND datafiles @D CHROME_CRASHPAD_PIPE_NAME VSCODE_HANDLES_UNCAUGHT_ERRORS .VARIABLES %D ^D %F VSCODE_CODE_CACHE_PATH LANG .LOADED TMP .INCLUDE_DIRS PROCESSOR_ARCHITEW6432 MAKEFLAGS ONEDRIVE CURDIR APPLICATION_INSIGHTS_NO_DIAGNOSTIC_CHANNEL *D PROGRAMFILES WALLABY_PRODUCTION MFLAGS .SHELLFLAGS COMMONPROGRAMW6432 +D lib.name MAKEFILE_LIST @F VSCODE_PID ?D *F <D VSCODE_NLS_CONFIG MAKE_HOST PROGRAMDATA SHELL CLASSPATH version HOMEPATH MAKECMDGOALS DRIVERDATA COMSPEC WINDIR MAKELEVEL MAKE PATH COMPUTERNAME MAKEFILES ^F PROMPT PDLIBBUILDER_DIR CHOCOLATEYLASTPATHUPDATE LOGONSERVER USERNAME COMMONPROGRAMFILES ?F PROGRAMW6432 encoder.class.sources PATHEXT class.sources +F ORIGINAL_XDG_CURRENT_DESKTOP metafile USERDOMAIN GNUMAKEFLAGS OS add-class-source __COMPAT_LAYER .DEFAULT_GOAL NVM_HOME MAKE_VERSION PROGRAMFILES(X86) USERDOMAIN_ROAMINGPROFILE NUMBER_OF_PROCESSORS externalsdir PUBLIC APPDATA HOMEDRIVE NVM_SYMLINK decoder.class.sources PROCESSOR_ARCHITECTURE VSCODE_AMD_ENTRYPOINT COMMONPROGRAMFILES(X86) ELECTRON_RUN_AS_NODE TEMP VSCODE_IPC_HOOK .RECIPEPREFIX <F SUFFIXES ALLUSERSPROFILE SESSIONNAME .FEATURES PROCESSOR_REVISION Makefile.pdlibbuilder PROCESSOR_IDENTIFIER JRE_HOME
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 743)
compile-cxx :=
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 420)
......@@ -122,7 +123,8 @@ lib.name := data-over-audio
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 726)
c.flags := -DPD -I "" -Wall -Wextra -Wshadow -Winline -Wstrict-aliasing -O3 -ffast-math -funroll-loops -fomit-frame-pointer
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 421)
common.objects :=
common
.objects :=
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 440)
shared.lib =
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 1)
......@@ -132,7 +134,7 @@ MAKEFILE_LIST := Makefile pd-lib-builder//Makefile.pdlibbuilder
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 408)
classes := encoder decoder
# environment
VSCODE_PID = 24284
VSCODE_PID = 36412
# automatic
?D = $(patsubst %/,%,$(patsubst %\,%,$(dir $?)))
# automatic
......@@ -140,8 +142,6 @@ VSCODE_PID = 24284
# automatic
<D = $(patsubst %/,%,$(patsubst %\,%,$(dir $<)))
# environment
BUILDLABEX = 22000.1.amd64fre.co_release.210604-1628
# environment
VSCODE_NLS_CONFIG = {"locale":"en-us","availableLanguages":{},"_languagePackSupport":true}
# default
MAKE_HOST := Windows32
......@@ -170,7 +170,7 @@ MAKELEVEL := 0
# default
MAKE = $(MAKE_COMMAND)
# environment
PATH = C:\Program Files (x86)\VMware\VMware Player\bin\;C:\Program Files\Amazon Corretto\jdk1.8.0_312\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\WINDOWS\System32\OpenSSH\;C:\Program Files\NVIDIA Corporation\NVIDIA NvDLISR;C:\Program Files (x86)\NVIDIA Corporation\PhysX\Common;C:\Program Files\CMake\bin;C:\ProgramData\chocolatey\bin;C:\Users\kumar\AppData\Roaming\nvm;C:\Program Files\nodejs;C:\Program Files\Amazon Corretto\jdk1.8.0_312;C:\Program Files\Amazon Corretto\;C:\Program Files\dotnet\;C:\Users\kumar\AppData\Local\Programs\Python\Python310\Scripts;C:\Program Files\Git\cmd;C:\MinGW\bin;;C:\Program Files\Docker\Docker\resources\bin;C:\ProgramData\DockerDesktop\version-bin;C:\Users\kumar\.cargo\bin;C:\Program Files\Amazon Corretto\jdk1.8.0_312\bin;C:\Users\kumar\AppData\Local\Programs\Microsoft VS Code\bin;C:\Users\kumar\AppData\Local\Programs\Python\Python310\Scripts;C:\MinGW\bin;
PATH = C:\Program Files (x86)\VMware\VMware Player\bin\;C:\Program Files\Amazon Corretto\jdk1.8.0_312\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\WINDOWS\System32\OpenSSH\;C:\Program Files\NVIDIA Corporation\NVIDIA NvDLISR;C:\Program Files (x86)\NVIDIA Corporation\PhysX\Common;C:\Program Files\CMake\bin;C:\ProgramData\chocolatey\bin;C:\Users\kumar\AppData\Roaming\nvm;C:\Program Files\nodejs;C:\Program Files\Amazon Corretto\jdk1.8.0_312;C:\Program Files\Amazon Corretto\;C:\Program Files\dotnet\;C:\Users\kumar\AppData\Local\Programs\Python\Python310\Scripts;C:\MinGW\bin;C:\Program Files\Docker\Docker\resources\bin;C:\ProgramData\DockerDesktop\version-bin;C:\Program Files\Git\cmd;C:\Users\kumar\.cargo\bin;C:\Program Files\Amazon Corretto\jdk1.8.0_312\bin;C:\Users\kumar\AppData\Local\Programs\Microsoft VS Code\bin;C:\Users\kumar\AppData\Local\Programs\Python\Python310\Scripts;C:\MinGW\bin;
# environment
COMPUTERNAME = DESKTOP-SBR69UV
# default
......@@ -254,8 +254,6 @@ PUBLIC = C:\Users\Public
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 732)
cxx.ldflags := $(subst ,, )
# environment
BUILDLAB = 22000.co_release.210604-1628
# environment
APPDATA = C:\Users\kumar\AppData\Roaming
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 711)
CFLAGS = $(warn.flags) $(optimization.flags) $(arch.c.flags)
......@@ -301,14 +299,15 @@ SESSIONNAME = Console
PROCESSOR_REVISION = 9e0a
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 369)
Makefile.pdlibbuilder = true
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 687)
# makefile (from 'pd-lib-builder//Makefile.pdlibbuilder', line 68
7)
installpath := /data-over-audio
# environment
PROCESSOR_IDENTIFIER = Intel64 Family 6 Model 158 Stepping 10, GenuineIntel
# environment
JRE_HOME = C:\Program Files\Amazon Corretto\jre8
# variable set hash-table stats:
# Load=145/1024=14%, Rehash=0, Collisions=12/260=5%
# Load=143/1024=14%, Rehash=0, Collisions=12/258=5%
# Pattern-specific Variable Values
......@@ -316,9 +315,9 @@ JRE_HOME = C:\Program Files\Amazon Corretto\jre8
# Directories
# . (key c:/msys64/home/kumar/gsoc/lib-data-over-audio, mtime 1657781759): 25 files, no impossibilities.
# . (key c:/msys64/home/kumar/gsoc/lib-data-over-audio, mtime 1657808915): 29 files, no impossibilities.
# 25 files, no impossibilities in 1 directories.
# 29 files, no impossibilities in 1 directories.
# Implicit Rules
......@@ -359,12 +358,12 @@ all:
# No general ('VPATH' variable) search path.
# strcache buffers: 1 (0) / strings = 29 / storage = 321 B / avg = 11 B
# current buf: size = 8174 B / used = 321 B / count = 29 / avg = 11 B
# strcache buffers: 1 (0) / strings = 33 / storage = 365 B / avg = 11 B
# current buf: size = 8174 B / used = 365 B / count = 33 / avg = 11 B
# strcache performance: lookups = 34 / hit rate = 14%
# strcache performance: lookups = 38 / hit rate = 13%
# hash-table stats:
# Load=29/8192=0%, Rehash=0, Collisions=0/34=0%
# Finished Make data base on Thu Jul 14 12:27:39 2022
# Load=33/8192=0%, Rehash=0, Collisions=0/38=0%
# Finished Make data base on Thu Jul 21 13:57:48 2022
# lib-data-over-audio
## Introduction
Lib-data-over-audio is a library in written in C and build for Pd(and it forks like Purr-data) for sending and reciving Pd messages by using audio as transmission medium. It also included help patches to explore the library's functionality.
## Getting started
Open encoder-test.pd and decoder-test.pd simultaneously to test sending receiving.
If not on Linux, to compile on your system run, <code>make clean</code> and then run <code>make all</code>
If things fail make sure <code>$PDDIR</code> is set to pd directory having src and bin files in it.
Ignore rest of the auto generated readme for now.
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://git.purrdata.net/ishankaler/lib-data-over-audio.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
- [ ] [Set up project integrations](https://git.purrdata.net/ishankaler/lib-data-over-audio/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
The the pre-built binaries are available with repository ending with: <code>.pd_linux</code> (for linux systems) and <code>.dll</code> for Windows systems.
## Test and Deploy
To simply get started, clone the repository and
open <code>test-suite.pd</code> to load the binaries and interact with the UI.
Use the built-in continuous integration in GitLab.
## Build
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
- Clone the repository to your local system.
- Make sure you have Pd installed on your system and <code>$PDDIR</code> is set to pd directory having src and bin files in it.
- cd into the repository and run <code>make clean</code> and then run <code>make all</code> to build the binaries.
- Run <code>test-suite.pd</code> to open the Pd interface and test the library.
***
## TODO
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
- [ ] add support for non-list messages
- [ ] add to deken, package management system for Pure Data externals
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Installation
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
## Contributing
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
......@@ -92,4 +40,4 @@ Show your appreciation to those who have contributed to the project.
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
No preview for this file type
/**
* The main idea is the list is treated as a string it character all character(including space)
* is encoded into freq value = base_frequency + (ascii value) * 10;
* it is then send at output stream with a delay in between them (500 msec for now)
* the value is preceded and succeed with some identifier values as stated above.
*
* This is code for encoder part of data over audio library.
* 29 start - the value is precedded by message.
* 30 end - the value is succeded by message.
......@@ -7,11 +12,9 @@
* 65-90 == A - Z
* 97 - 122 == a - z
* 91-96 and 123-126 == special characters
* The main idea is the list is treated as a string it character all character(including space)
* is encoded into freq value = base_frequency + (ascii value) * 10;
* it is then send at output stream with a delay in between them (500 msec for now)
* the value is preceded and succeed with some identifier values as stated above.
*/
*
*
// SOME EXAMPLE CONVERSIONS
// [1, 2, 3], n extra, log2(n) time
// [1, 2, 3]
// ['a', 'b', '\0]
......@@ -26,9 +29,6 @@
// 1- ishan kaler
// AAAB -> A3B -> 65, 31, 3, 31, 66, 31, 1, 31
// 1s r1 r2 ...
/**
* include the interface to Pd
*/
......@@ -49,7 +49,6 @@ static t_class *encoder_class;
typedef struct _encoder {
t_object x_obj;
cvector_vector_type(char*) messageQueue;
// char messageStr[1000];
char* messageStr;
int messageIndex;
int runLengthEncodedStream[1000];
......
No preview for this file type
No preview for this file type
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment