Package: cdm-devkit
Developer tools for Coco-de-Mer processorsInstallationDownloadlatest versionInstall Python packagefrom.whlfileRunpip install cdm-devkit-x.x.x.whlPackage will be published to PyPI soonInstall VS Code extensionfrom.vsixfileRemove all other extensions that add support for CdM processorsOpen Command PaletteCtrl+Shift+PTypevsixSelectInstall from VSIXSelectvscode-cdm-extension-x.x.x.vsixRead moreExtension will be published to VS Code Marketplace soonDevelopment kit contentsAfter installation you get several components:CLI Programscocas- assembler for CdM processorscocodump- disassembler for CdM processorssynthm- secondary decoder synthesis utility(coming soon)VS Code ExtensionAssembler language support for all CdM processors (syntax highlighting and code snippets)Debug support(coming soon)cdm-devkit-miscarchiveProcessor implementations (./)Logisim libraries (jar/)logisim-banked-memory- banked memory forcdm16logisim-cdm-emulator- emulated CdM processorsCode and scheme examples (examples/)Getting startedCheck out ourGetting Statedguide.DocumentationWe are working on documentation, it will be available soon.However, some docs are available indocs/directory.Report a bugYou can report a bug with GitHub Issues.Open new issuehereUse a templateProvide a proper name and description of a problemProvide information on how to reproduce a bugSetting up development environmentPython-based projectsusePoetryas build systemInstallPoetryRunpoetry installto download dependenciescocasusesANTLRto parse assembly languageantlr4-python3-runtimeis needed to runcocasand is installed with other dependenciesHowever, if you want to fiddle with grammar files and generate new parser you would need to installantlr4-tools, this package is installed with development dependencies (Read more)Java-based projectsuseGradleas build systemInstallJDKgradlewscript should downloadGradleautomatically on first runVS Code Extensionusesofficial toolsBuildingBuilding individual projectsPython-based projects:Runpoetry buildJava-based projects:Navigate to project folderRun./gradlew jar(on Unix)Run.\gradlew.bat jar(on Windows)VS Code extension:Navigate tovscode-cdm-extension/Runvsce packageBuilding all projects at onceThere is aMakefilethat will build all projects and prepare files for distributionRunmaketo build all projectsSetVERSIONvariable if you want to specify project versionExample:make VERSION=1.2.3VERSIONshould be valid SemVer versionYou can getmakeon Windows from GnuWin32 project.For Windows 10 and above:Runwinget install GnuWin32.MakeMaybe you would need to addbin/directory of make to yourPATHUsingChocolatey:Runchoco install makeYou can read about other installation methodshereContributingAll contributions should be done viapull requests.Commit messages should be written according tothese guidelinesCommit messages should start with ascope identifier- project name surrounded by square brackets. That will help to determine which project commit belongs to.Example:[cocas] Add new featureCommits related to whole repository shouldn't use scope identifierPossible scope identifiers are:General:docsci/cdexamplestestsProcessor implementations:cdm*Projects:cocascocoemucocodumpsynthmlogisim-banked-memorylogisim-cdm-emulatorlogisim-runnervscode-cdm-extensionContact usIf you have a proposal or a suggestion you are free to open a GitHub Issuehere.For other questions contact:Email:n.repin@g.nsu.ruTelegram:@cdm_updates(channel with updates, linked chat for support)