create-academic-research 0.1.10 → 0.1.12

package/README.md

@@ -1,8 +1,19 @@
 # Create Academic Research
 
+[![npm](https://img.shields.io/npm/v/create-academic-research)](https://www.npmjs.com/package/create-academic-research)
+[![Validate](https://github.com/VincenzoImp/create-academic-research/actions/workflows/validate.yml/badge.svg)](https://github.com/VincenzoImp/create-academic-research/actions/workflows/validate.yml)
+[![Release](https://github.com/VincenzoImp/create-academic-research/actions/workflows/release.yml/badge.svg)](https://github.com/VincenzoImp/create-academic-research/actions/workflows/release.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
 Create agent-ready academic research repositories with one command.
 
-From the npm registry:
+`create-academic-research` scaffolds a serious research workspace: source
+ledgers, SOTA files, citation audit tables, experiment records, reproducibility
+docs, durable wiki/log memory, project-local skills, and MCP setup for scholarly
+search. The template is discipline-general and especially strong for computer
+science research.
+
+## Quickstart
 
 ```bash
 npm create academic-research@latest my-project
@@ -23,9 +34,16 @@ From GitHub:
 npx --yes github:VincenzoImp/create-academic-research my-project
 ```
 
-The generator creates a complete research repository, personalizes the project
-name and Python package, configures project-local skills, writes MCP records,
-and prepares a durable wiki/log structure for agentic academic work.
+## What It Creates
+
+| Area | Generated Support |
+|---|---|
+| Sources | PDFs, derived Markdown, metadata, BibTeX, conversion ledger, source ledger. |
+| Literature Review | Search strategy, screening decisions, literature matrix, SOTA synthesis, gaps, PRISMA flow. |
+| Agent Memory | `AGENTS.md`, capability profile, MCP setup docs, generated MCP snippets, wiki index/log/templates. |
+| Reproducibility | Python package scaffold, tests, experiment registry, output folders, artifact checklist. |
+| Skills | Project-local installation flow for `VincenzoImp/academic-research-skills`. |
+| MCP | Conservative default records for scholarly discovery plus documented optional integrations. |
 
 The wizard is discipline-general: it creates a clean structure for academic
 research projects in any field. Its companion skill stack gives first-class
@@ -40,6 +58,15 @@ a specific target recognized by the `skills` CLI. Run
 `npx academic-research agents list` inside a generated project to see every
 supported target and alias.
 
+## When To Use It
+
+Use this when starting or cleaning up an academic research project that needs
+evidence tracking, literature-review discipline, repeatable experiments, paper
+writing support, or LLM-agent collaboration. It is not a paper generator and it
+does not replace methodological judgment; it gives the repository enough
+structure for serious research work to compound instead of scattering across
+chat history, notebooks, PDFs, and ad hoc folders.
+
 ## Default Experience
 
 By default, the wizard:
@@ -229,8 +256,8 @@ Releases are tag-driven. Update `package.json` and `package-lock.json`, commit
 the change, create `vX.Y.Z`, and push the tag:
 
 ```bash
-git tag -a v0.1.10 -m "v0.1.10"
-git push origin main v0.1.10
+git tag -a v0.1.12 -m "v0.1.12"
+git push origin main v0.1.12
 ```
 
 Once the GitHub repository is public, the release workflow validates the tag

package/dist/src/project.js

@@ -1,4 +1,4 @@
-import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { mkdir, readFile, rm, writeFile } from "node:fs/promises";
 import { basename, dirname, join, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
 import YAML from "yaml";
@@ -97,6 +97,7 @@ export async function createProject(options) {
     }
     await mkdir(dirname(target), { recursive: true });
     await copyDirectory(templateRoot, target);
+    await writeGeneratedGitignore(target);
     await personalizeProject(target, { title, slug, packageName, profile: options.profile ?? "academic-general" });
     await writeGeneratedPackageJson(target, { slug });
     await writeAgentStack(target);
@@ -130,6 +131,7 @@ export async function doctorProject(root) {
     const errors = [];
     const required = [
         "README.md",
+        ".gitignore",
         ".env.example",
         "package.json",
         "pyproject.toml",
@@ -227,6 +229,13 @@ async function writeGeneratedPackageJson(root, { slug, preserveExistingSpec = fa
     };
     await writeJson(path, data);
 }
+async function writeGeneratedGitignore(root) {
+    const source = join(root, "_gitignore");
+    if (await exists(source)) {
+        await writeFile(join(root, ".gitignore"), await readFile(source, "utf8"), "utf8");
+        await rm(source);
+    }
+}
 async function currentPackageVersion() {
     const packageJson = await readJson(join(packageRoot, "package.json"));
     if (!packageJson.version) {

package/package.json

@@ -1,17 +1,24 @@
 {
   "name": "create-academic-research",
-  "version": "0.1.10",
-  "description": "Create and manage agent-ready academic research repositories.",
+  "version": "0.1.12",
+  "description": "Scaffold agent-ready academic research repositories with SOTA, source ledgers, wiki memory, MCP setup, and project-local skills.",
   "type": "module",
   "license": "MIT",
   "author": "Vincenzo Imperati",
   "keywords": [
     "academic-research",
+    "academic-writing",
+    "arxiv",
+    "citation-management",
     "research-project",
+    "research-scaffold",
     "agent-skills",
+    "llm-agents",
     "mcp",
     "literature-review",
-    "reproducibility"
+    "open-science",
+    "reproducibility",
+    "sota"
   ],
   "repository": {
     "type": "git",

package/template/_gitignore

@@ -0,0 +1,62 @@
+.DS_Store
+node_modules/
+dist/
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+data/raw/**
+!data/raw/
+!data/raw/.gitkeep
+data/interim/**
+!data/interim/
+!data/interim/.gitkeep
+data/processed/**
+!data/processed/
+!data/processed/.gitkeep
+data/external/**
+!data/external/
+!data/external/.gitkeep
+outputs/**
+!outputs/
+!outputs/**/
+!outputs/**/.gitkeep
+analysis_outputs/**
+!analysis_outputs/
+!analysis_outputs/.gitkeep
+debug_outputs/**
+!debug_outputs/
+!debug_outputs/.gitkeep
+repro_outputs/**
+!repro_outputs/
+!repro_outputs/.gitkeep
+train_outputs/**
+!train_outputs/
+!train_outputs/.gitkeep
+explore_outputs/**
+!explore_outputs/
+!explore_outputs/.gitkeep
+artifacts/releases/**
+!artifacts/releases/
+!artifacts/releases/.gitkeep
+artifacts/data/**
+!artifacts/data/
+!artifacts/data/.gitkeep
+artifacts/models/**
+!artifacts/models/
+!artifacts/models/.gitkeep
+artifacts/cache/**
+!artifacts/cache/
+!artifacts/cache/.gitkeep
+docs/agent/generated/*.local.json
+.env
+.env.*
+!.env.example
+!.gitkeep
+!README.md

package/template/package.json

@@ -17,6 +17,6 @@
     "mcp:probe": "academic-research mcp probe"
   },
   "devDependencies": {
-    "create-academic-research": "0.1.10"
+    "create-academic-research": "0.1.12"
   }
 }